<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>i3c: xi3c_slave_intr_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">i3c
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xi3c__slave__intr__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xi3c_slave_intr_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>Design example to use the I3C device as slave in interrupt mode. </p>
<p>It performs the send and receive operations in slave mode.</p>
<p>Note: Master need to check for slave devices availability and then assign address.</p>
<pre> MODIFICATION HISTORY:</pre><pre>Ver   Who Date     Changes
</p>
<hr/>
<p>
1.2 gm   02/18/25  Add support for Slave mode</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aabd9a17bad898a69a8cf81b2d25a3933"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xi3c__slave__intr__example_8c.html#aabd9a17bad898a69a8cf81b2d25a3933">I3cSlaveIntrExample</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:aabd9a17bad898a69a8cf81b2d25a3933"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function does a minimal test on the I3c device and driver as a design example.  <a href="#aabd9a17bad898a69a8cf81b2d25a3933">More...</a><br/></td></tr>
<tr class="separator:aabd9a17bad898a69a8cf81b2d25a3933"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaffcbc6e824beea448fe0c4a4ffe15c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xi3c__slave__intr__example_8c.html#aaffcbc6e824beea448fe0c4a4ffe15c8">Handler</a> (u32 Event)</td></tr>
<tr class="memdesc:aaffcbc6e824beea448fe0c4a4ffe15c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the handler which updates transfer status up on events from the I3C.  <a href="#aaffcbc6e824beea448fe0c4a4ffe15c8">More...</a><br/></td></tr>
<tr class="separator:aaffcbc6e824beea448fe0c4a4ffe15c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xi3c__slave__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the interrupt example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aaffcbc6e824beea448fe0c4a4ffe15c8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Handler </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Event</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the handler which updates transfer status up on events from the I3C. </p>
<p>It is called from an interrupt context such that the amount of processing performed should be minimized.</p>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="aabd9a17bad898a69a8cf81b2d25a3933"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int I3cSlaveIntrExample </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function does a minimal test on the I3c device and driver as a design example. </p>
<p>The purpose of this function is to illustrate how to use the <a class="el" href="struct_x_i3c.html" title="The XI3c driver instance data. ">XI3c</a> driver.</p>
<p>This function sends and receives data through the I3C.</p>
<p>This function uses interrupt driver mode of the I3C.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the Device ID of the I3c Device and is the XPAR_&lt;I3C_instance&gt;_DEVICE_ID value from xparameters.h</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>&lt; Test data </p>

<p>References <a class="el" href="struct_x_i3c___config.html#a5022354efb94520441dca651cb9643bc">XI3c_Config::BaseAddress</a>, <a class="el" href="xi3c__intr__example_8c.html#aaffcbc6e824beea448fe0c4a4ffe15c8">Handler()</a>, <a class="el" href="group___overview.html#ga3a6f3237b5eecb5d9144c3254dbab088">XI3c_CfgInitialize()</a>, <a class="el" href="group___overview.html#ga6707c3c86ecbb35f037252f3db9b57aa">XI3c_IsDyncAddrAssigned</a>, <a class="el" href="group___overview.html#ga8212bca3426c2ca6a284e5de2a5a9180">XI3c_LookupConfig()</a>, <a class="el" href="group___overview.html#gaa8b632c4926c7125ffe178ec72a167db">XI3c_SetStatusHandler()</a>, <a class="el" href="group___overview.html#ga64fba1f66dc69a20b21f414cccb90752">XI3c_SlaveInterruptHandler()</a>, <a class="el" href="group___overview.html#ga9808772192d0f16adaf33e61b784e3a3">XI3c_SlaveRecv()</a>, and <a class="el" href="group___overview.html#ga28021172cfe5d1d3dfb20e8f3f58c94f">XI3c_SlaveSend()</a>.</p>

<p>Referenced by <a class="el" href="xi3c__slave__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the interrupt example. </p>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, XST_FAILURE if unsuccessful.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xi3c__slave__intr__example_8c.html#aabd9a17bad898a69a8cf81b2d25a3933">I3cSlaveIntrExample()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
